Management API

Base Resource URL:


                    https://sandbox-portal.tidypay.com/api/v01/customers/[customer-id]/[transactions]

Provides access to the transactions associated with the specified customer.

Resource URL	Description
https://sandbox-portal.tidypay.com/api/v01/customers/[customer-id]/[transactions]/[transaction-id]	Provides access to management of the specified transaction.

create

Method: PUT	Implicit: Yes	Returns: Transaction *
Consumes: json, xml		Produces: json, xml

Creates a transaction associated with the specified customer.

Parameters:

#	Name	Type	Required	Default	Description
01	object	Transaction *	Yes		Represents a transaction associated with a particular merchant.

find

Method: GET	Implicit: Yes	Returns: Transaction[] *
Consumes: xurl		Produces: json, xml

Returns a list of the transactions associated with the specified customer.

Parameters:

#	Name	Type	Required	Default	Description
01	offset	Integer	No	0	Index of the first record returned to the customer from the search result of a web search.
02	limit	Integer	No	100	Maximum number of records to load per single search web call made by the customer.
03	createDateFrom	Date	No		The starting date for filtering transaction records; only records dated from this specific day onwards are included.
04	createDateTo	Date	No		The concluding date for filtering transaction records; only records up to and through this specified date are included.

process

Method: POST	Implicit: No	Returns: Transaction *
Consumes: json, xml		Produces: json, xml

Creates and processes a transaction associated with the specified customer.

Parameters:

#	Name	Type	Required	Default	Description
01	object	ProcessingRequest *	Yes		Represents information included in processing request sent to a processor.

All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.